On this CD you will find the OpenDoc Development Framework (ODF) Release 1.
This release supports OpenDoc 1.0.x for Macintosh only. If you want to do Windows part development, you should use the ODF 1.0d8 release, which supports both OpenDoc DR1 for Windows and OpenDoc DR2 for Macintosh. The OpenDoc API changed so much since DR1 that it became impractical for us to continue to support both APIs in the same code base. We are still committed to supporting OpenDoc for Windows when that API reaches a level that allows us to do so.
Since our 1.0d11 release of ODF on the OpenDoc DR4 CD we've moved portions of ODF into a SOM-based shared library to reduce the size of resulting sample parts and provide better code re-use. Currently, this library contains most of the Foundation and OS layers. As development continues we will attempt to move more of the framework into this shared library. As a result of this move, you should be aware that this release requires your parts to be dynamically linked to the ODFLibrary.
This release supports the following development environments for PowerPC:
- Metrowerks CodeWarrior 8.0
- Symantec C++ for Power Macintosh 8.0 (Rainbow) (1)
- MrC for MPW.
This release supports the following build environments for 68K:
- Symantec C++ for MPW
- CodeWarrior 8 for 68K. (2)
Please refer to the "Getting Started" folder for specific instructions on configuring your compiler for use with ODF.
(1) Altough we provide projects for the Symantec C++ IDE, they will not build correctly. We are working with Symantec to resolve those problems and will be posting an update on our Web page as soon as possible.
(2) Because of problems with the MetroWerks' 68K Compiler, ODF based parts will build but not run correctly. Check the document "CodeWarrior 68K Problems" in the Documentation folder for more details.
Contents of This CD
Getting Started
This folder contains the installation and build guides for setting up ODF and configuring your development environment. This folder also contains the ODF installer for CodeWarrior.
PartMaker
Contains the PartMaker application and templates for creating new ODF projects.
ODFDev
This folder contains the ODF development environment. Inside this folder you will find the source code for ODF and its samples, and you will also find the ODF build environment support. See the Introduction of the ODF Developer's Guide for an overview of the ODF layer and subsystem organization.
If you are using CodeWarrior, you can use the quick-start installer to copy this folder to your local hard drive and configure your CodeWarrior environment. If you are using any other compiler, you will have to copy this folder manually for now. See the Installation Guide in the 'Getting Started' folder for more information about setting up your development environment.
Tools & Goodies
This folder contains a collection of tools and goodies. The following is a list of the Tools subfolders and their contents:
- CodeWarrior Goodies: contains an AppleScript script to easily generate a release project from a debug project.
- Object Master™: contains a project file that is set up for parsing ODF source code.
- MacBrowse: contains the MacBrowse application and the MacParse AppleScript and tool.
- Merged Parts: contains projects and information on how to merge your part suite into one shared library to reduce your footprint.
- IntlTest: contains a part-in-progress that was written to test various international aspects of ODF.
- More View Resources: this folder contains examples of more View Resource types.
Documentation
This folder contains the documentation for ODF. In addition to the folders listed below this folder includes three documents that cover the table of contents for the documentation, a description of the development state of this release of ODF, and how to use the search capabilities of Acrobat.
- ODF Dev Guides: contains the ODF Developer's Guide which is provided as a searchable document that can be read using Adobe Acrobat Reader 2.1 (provided on this CD).
- Class Reference: contains the ODF Class Reference which is provided as a QuickView navigable database and as an Adobe Acrobat document. Use the QuickView application provided in the same folder as the ODF Class Reference to navigate the reference.
- Engineering Notes: contains information related to the ODF framework layer not covered in the ODF Dev Guides and Class Reference.
- Development Notes: contains information related to the ODF build system and sample parts.
The Engineering Release Notes and all other documents are text files that you can read using SimpleText.
ODF Sample Parts
The contents of this folder are targeted at people who simply want to try out the ODF sample parts. This folder contains the whole suite of ODF sample parts (release build, for both 68K and PowerPC). Please note: these part editors were written to demonstrate ODF. They were not written with the intention of becoming commercial part editors.
This folder contains:
- Editors (68K): 68K version of the ODF sample parts (release build). Copy these files to your Editors folder if you are using a 68K Macintosh.
- Editors (PPC): PowerPC version of the ODF sample parts (release build). Copy these files to your Editors folder if you are using a Power Macintosh.
- Stationery: contains stationery files for the ODF sample parts. Copy these files to your Stationery folder.
- Documents: contains an interesting document and script to show case scripting in the ODFDraw Part.
ODFLibrary 1.0
This folder contains the ODFLibrary version 1.0. This is a fat library, release build (both 68K and PowerPC). This is the library you must ship with your ODF based part editors. Don't forget to carefully read the License Agreement documents contained in the Licensing folder at the top level of the OpenDoc DR5 CD.
Install the ODFLibrary along with your part editors into the 'Editors' folder. If an ODFLibrary is already present, make sure to check the version number. Do not install an older version over a more recent one. The correct ODFLibrary will maintain release to release binary compatibility so you can be sure that your part editor will always be working with the most recent version.
Developer University
This folder contains the sample parts and code from the Creating OpenDoc Parts class taught by Apple's Developer University.
ODF & Cyberdog
This folder contains the ODF support for Cyberdog, Apple's collection of Internet tools. If you are interested in developing a CyberDog part, you can copy the contents of this folder into your ODFDev folder.
Check this folder if you are interested in developing a Cyberdog part. Full Cyberdog support will be integrated into a future release of ODF.
Release Schedule
We plan to ship three releases of ODF each year. Each release will include incremental improvements, feature additions, and bug fixes while maintaining release-to-release binary compatibility. We will communicate our plans and release dates for each upcoming release through the ODF-Interest list.
Developer feedback will help us prioritize our efforts to best serve your needs. We encourage you to voice your opinions, needs, & desires to the ODF-Interest list. See the Developer Feedback section below for information on how to subscribe to ODF-Interest.
Development State
ODF is divided into three layers each containing a number of subsystems. In ODF Release 1 the Foundation and OS layers are of final quality. The ODF Shared Library is a 1.0 version that we will maintain release-to-release binary compatibility with. The framework layer has subsystems that span the range from pre-alpha to beta quality. The view system has the basic Macintosh controls at a beta level. Scripting support is in development, with support for receiving and sending AppleEvents at an alpha level while support for attachability and recordability will come in a future release. ODF Release 1 supports most of the OpenDoc recipes at a beta level with a few exceptions.
For a detailed look at the development state of the various subsystems of ODF Release 1 please refer to the document.ODF Release 1 Development State in the 'Documentation' folder.
The ODF Class Reference is current with the API's in the Foundation and OS layers. The Framework layer will be documented in the upcoming releases of theODF Class Reference. The ODF Developer's Guide has a few portions where it is not current with this release. Please refer to the ODF Developer's Guide Update for the late breaking changes.
Where to Go From Here
If you want to play with the ODF part editors, copy the appropriate part editors and stationery files from the 'ODF Sample Parts' folder to your system, as described earlier. You must also copy the ODFLibrary to your Editors folder since the ODF sample parts need this shared library to run.
If you want to begin building ODF parts right away, begin by installing ODF on your system. Go to the 'Getting Started' folder and follow the instructions in theInstallation Guide and theBuild Guide.
If you want information about the latest changes to ODF, read the ODF 1 Development State document in the 'Documentation' folder. You can also get information about the latest changes to ODF by reading the documents contained in the 'Documentation:Engineering Notes' folder.
If you want to learn more about how ODF works, begin reading theODF Developer's Guide. This book contains tutorial and programmer information to help you solve your problems and to give you an understanding of how ODF interacts with OpenDoc. The ODF Developer's Guide is located in the 'Documentation' folder. See also the document 'ODF Developer's Guide Update' containing some last minute corrections. Check our web site at 'http://www.devtools.apple.com/odf/' for the most up-to-date documentation.
If you need class or method information, consult the ODF Class Reference.. This book is provided as both an Adobe Acrobat file and a QuickView database to make navigating through the classes and methods easier. The ODF Class Reference is located in the 'Documentation' folder.
Developer Feedback
We appreciate any input you have regarding ODF and how it should evolve to meet your needs. A list server has been set up to handle discussions pertaining to ODF. To get yourself added to the list, send a message to 'listproc@cilabs.org' and include the following in the body of your message:
SUBSCRIBE ODF-INTEREST Your Name
Messages can be posted to the ODF-Interest list by sending mail to 'ODF-interest@CILabs.org'.
You can also get the latest information about ODF by visiting the ODF web site at 'http://www.devtools.apple.com/odf/'
How to Report Problems
Please send bugs or comments to the ODF list server “ODF-Interest@cilabs.org”.
